<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>axiethernet: XAvb_BmcData Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">axiethernet
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('struct_x_avb___bmc_data.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">XAvb_BmcData Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>This typedef defines the format for a data structure which stores the relevant fields which are captured from Announce Packets.  
 <a href="struct_x_avb___bmc_data.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:ae60a5e9cd8c572d2db805650287483f7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_avb___port_identity.html">XAvb_PortIdentity</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_avb___bmc_data.html#ae60a5e9cd8c572d2db805650287483f7">SourcePortIdentity</a></td></tr>
<tr class="memdesc:ae60a5e9cd8c572d2db805650287483f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Announce message: sourcePortIdentity.  <a href="#ae60a5e9cd8c572d2db805650287483f7">More...</a><br/></td></tr>
<tr class="separator:ae60a5e9cd8c572d2db805650287483f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa842c05dfde7a1dccd0a48c906c742d9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_avb___clock_identity.html">XAvb_ClockIdentity</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_avb___bmc_data.html#aa842c05dfde7a1dccd0a48c906c742d9">GrandmasterIdentity</a></td></tr>
<tr class="memdesc:aa842c05dfde7a1dccd0a48c906c742d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Announce message: grandmasterIdentity.  <a href="#aa842c05dfde7a1dccd0a48c906c742d9">More...</a><br/></td></tr>
<tr class="separator:aa842c05dfde7a1dccd0a48c906c742d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa82e09ae59ed634e54fdcfebe78d10d2"><td class="memItemLeft" align="right" valign="top">u16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_avb___bmc_data.html#aa82e09ae59ed634e54fdcfebe78d10d2">stepsRemoved</a></td></tr>
<tr class="memdesc:aa82e09ae59ed634e54fdcfebe78d10d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Announce message: stepsRemoved.  <a href="#aa82e09ae59ed634e54fdcfebe78d10d2">More...</a><br/></td></tr>
<tr class="separator:aa82e09ae59ed634e54fdcfebe78d10d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a463904e4270ced5a6c437e68fad3b98f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_avb___clock_quality.html">XAvb_ClockQuality</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_avb___bmc_data.html#a463904e4270ced5a6c437e68fad3b98f">ClockQuality</a></td></tr>
<tr class="memdesc:a463904e4270ced5a6c437e68fad3b98f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Announce message: grandmasterClockQuality.  <a href="#a463904e4270ced5a6c437e68fad3b98f">More...</a><br/></td></tr>
<tr class="separator:a463904e4270ced5a6c437e68fad3b98f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a206dca9ffafe9d7fbf0019402127e6dd"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_avb___bmc_data.html#a206dca9ffafe9d7fbf0019402127e6dd">GrandmasterPriority1</a></td></tr>
<tr class="memdesc:a206dca9ffafe9d7fbf0019402127e6dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Announce message: grandmasterPriority1.  <a href="#a206dca9ffafe9d7fbf0019402127e6dd">More...</a><br/></td></tr>
<tr class="separator:a206dca9ffafe9d7fbf0019402127e6dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab345aec9e45cac47fddee9e48724c9ef"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_avb___bmc_data.html#ab345aec9e45cac47fddee9e48724c9ef">GrandmasterPriority2</a></td></tr>
<tr class="memdesc:ab345aec9e45cac47fddee9e48724c9ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Announce message: grandmasterPriority2.  <a href="#ab345aec9e45cac47fddee9e48724c9ef">More...</a><br/></td></tr>
<tr class="separator:ab345aec9e45cac47fddee9e48724c9ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d3619e11c42446854d5438dab27e84a"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_avb___bmc_data.html#a7d3619e11c42446854d5438dab27e84a">IAmTheRtcMaster</a></td></tr>
<tr class="memdesc:a7d3619e11c42446854d5438dab27e84a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Boolean: 1 = grandmaster, 0 = slave.  <a href="#a7d3619e11c42446854d5438dab27e84a">More...</a><br/></td></tr>
<tr class="separator:a7d3619e11c42446854d5438dab27e84a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a112462d30d91fae9ea7f01d6b275e3d0"><td class="memItemLeft" align="right" valign="top">u16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_avb___bmc_data.html#a112462d30d91fae9ea7f01d6b275e3d0">tlvLengthField</a></td></tr>
<tr class="memdesc:a112462d30d91fae9ea7f01d6b275e3d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Announce message: lengthField (for TLV)  <a href="#a112462d30d91fae9ea7f01d6b275e3d0">More...</a><br/></td></tr>
<tr class="separator:a112462d30d91fae9ea7f01d6b275e3d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1a43181c99b74fbac809dc9b833509e"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_avb___bmc_data.html#ae1a43181c99b74fbac809dc9b833509e">logMessageInterval</a></td></tr>
<tr class="memdesc:ae1a43181c99b74fbac809dc9b833509e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Announce message: logMessageInterval.  <a href="#ae1a43181c99b74fbac809dc9b833509e">More...</a><br/></td></tr>
<tr class="separator:ae1a43181c99b74fbac809dc9b833509e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3bcc274ccdd364fe5983d586b5cff62"><td class="memItemLeft" align="right" valign="top">u16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_avb___bmc_data.html#af3bcc274ccdd364fe5983d586b5cff62">AnnounceIntervalDuration</a></td></tr>
<tr class="memdesc:af3bcc274ccdd364fe5983d586b5cff62"><td class="mdescLeft">&#160;</td><td class="mdescRight">Announce Interval in units of 1/128 secs.  <a href="#af3bcc274ccdd364fe5983d586b5cff62">More...</a><br/></td></tr>
<tr class="separator:af3bcc274ccdd364fe5983d586b5cff62"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This typedef defines the format for a data structure which stores the relevant fields which are captured from Announce Packets. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="af3bcc274ccdd364fe5983d586b5cff62"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u16 XAvb_BmcData::AnnounceIntervalDuration</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Announce Interval in units of 1/128 secs. </p>

<p>Referenced by <a class="el" href="xavb__ptp__bmca_8c.html#a5eaf575de699cb2f054a43daa8a93849">XAvb_DecodeRxAnnounceFrame()</a>, and <a class="el" href="xavb_8h.html#aab96c1602bda46380e25d0bb03a8ac01">XAvb_PtpTimerInterruptHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="a463904e4270ced5a6c437e68fad3b98f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_avb___clock_quality.html">XAvb_ClockQuality</a> XAvb_BmcData::ClockQuality</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Announce message: grandmasterClockQuality. </p>

<p>Referenced by <a class="el" href="xavb__ptp__bmca_8c.html#ae38ec83a381d57348fdbaf065c2190eb">XAvb_BestMasterClockAlgorithm()</a>, <a class="el" href="xavb__ptp__bmca_8c.html#a5eaf575de699cb2f054a43daa8a93849">XAvb_DecodeRxAnnounceFrame()</a>, <a class="el" href="xavb__ptp__bmca_8c.html#a4091121232495f00535ca134664b4f7c">XAvb_DecodeTxAnnounceFrame()</a>, <a class="el" href="xavb__ptp__bmca_8c.html#a7c77fd7953811584a36001e5e74165b3">XAvb_ReadAnnounceFrame()</a>, and <a class="el" href="xavb__ptp__bmca_8c.html#a2234b9dec3b039479123f49ee573a14e">XAvb_UpdateBmcRecords()</a>.</p>

</div>
</div>
<a class="anchor" id="aa842c05dfde7a1dccd0a48c906c742d9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_avb___clock_identity.html">XAvb_ClockIdentity</a> XAvb_BmcData::GrandmasterIdentity</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Announce message: grandmasterIdentity. </p>

<p>Referenced by <a class="el" href="xavb__ptp__bmca_8c.html#ae38ec83a381d57348fdbaf065c2190eb">XAvb_BestMasterClockAlgorithm()</a>, <a class="el" href="xavb__ptp__bmca_8c.html#a5eaf575de699cb2f054a43daa8a93849">XAvb_DecodeRxAnnounceFrame()</a>, <a class="el" href="xavb__ptp__bmca_8c.html#a4091121232495f00535ca134664b4f7c">XAvb_DecodeTxAnnounceFrame()</a>, <a class="el" href="xavb__ptp__bmca_8c.html#a7c77fd7953811584a36001e5e74165b3">XAvb_ReadAnnounceFrame()</a>, and <a class="el" href="xavb__ptp__bmca_8c.html#a2234b9dec3b039479123f49ee573a14e">XAvb_UpdateBmcRecords()</a>.</p>

</div>
</div>
<a class="anchor" id="a206dca9ffafe9d7fbf0019402127e6dd"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XAvb_BmcData::GrandmasterPriority1</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Announce message: grandmasterPriority1. </p>

<p>Referenced by <a class="el" href="xavb__ptp__bmca_8c.html#ae38ec83a381d57348fdbaf065c2190eb">XAvb_BestMasterClockAlgorithm()</a>, <a class="el" href="xavb__ptp__bmca_8c.html#a5eaf575de699cb2f054a43daa8a93849">XAvb_DecodeRxAnnounceFrame()</a>, <a class="el" href="xavb__ptp__bmca_8c.html#a4091121232495f00535ca134664b4f7c">XAvb_DecodeTxAnnounceFrame()</a>, <a class="el" href="xavb__ptp__bmca_8c.html#a7c77fd7953811584a36001e5e74165b3">XAvb_ReadAnnounceFrame()</a>, and <a class="el" href="xavb__ptp__bmca_8c.html#a2234b9dec3b039479123f49ee573a14e">XAvb_UpdateBmcRecords()</a>.</p>

</div>
</div>
<a class="anchor" id="ab345aec9e45cac47fddee9e48724c9ef"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XAvb_BmcData::GrandmasterPriority2</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Announce message: grandmasterPriority2. </p>

<p>Referenced by <a class="el" href="xavb__ptp__bmca_8c.html#ae38ec83a381d57348fdbaf065c2190eb">XAvb_BestMasterClockAlgorithm()</a>, <a class="el" href="xavb__ptp__bmca_8c.html#a5eaf575de699cb2f054a43daa8a93849">XAvb_DecodeRxAnnounceFrame()</a>, <a class="el" href="xavb__ptp__bmca_8c.html#a4091121232495f00535ca134664b4f7c">XAvb_DecodeTxAnnounceFrame()</a>, <a class="el" href="xavb__ptp__bmca_8c.html#a7c77fd7953811584a36001e5e74165b3">XAvb_ReadAnnounceFrame()</a>, and <a class="el" href="xavb__ptp__bmca_8c.html#a2234b9dec3b039479123f49ee573a14e">XAvb_UpdateBmcRecords()</a>.</p>

</div>
</div>
<a class="anchor" id="a7d3619e11c42446854d5438dab27e84a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XAvb_BmcData::IAmTheRtcMaster</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Boolean: 1 = grandmaster, 0 = slave. </p>

<p>Referenced by <a class="el" href="xavb__ptp__bmca_8c.html#a5ef1c55c51f5781c4395ff20cc07f410">XAvb_BecomeRtcMaster()</a>, <a class="el" href="xavb__ptp__bmca_8c.html#a52eb3269ef7daea39a316315d903c43c">XAvb_BecomeRtcSlave()</a>, <a class="el" href="xavb__ptp__bmca_8c.html#a5eaf575de699cb2f054a43daa8a93849">XAvb_DecodeRxAnnounceFrame()</a>, <a class="el" href="xavb__ptp__packets_8c.html#afb8650c4c94082dc746db9ec0259e1cb">XAvb_DecodeRxFollowUp()</a>, <a class="el" href="xavb__ptp__packets_8c.html#a3ed6d94f92c94a88dce9444e8a27fe8a">XAvb_DecodeRxSync()</a>, <a class="el" href="xavb__ptp__bmca_8c.html#a4091121232495f00535ca134664b4f7c">XAvb_DecodeTxAnnounceFrame()</a>, and <a class="el" href="xavb_8h.html#aab96c1602bda46380e25d0bb03a8ac01">XAvb_PtpTimerInterruptHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="ae1a43181c99b74fbac809dc9b833509e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char XAvb_BmcData::logMessageInterval</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Announce message: logMessageInterval. </p>
<p>NOTE: 8-bit signed integer </p>

<p>Referenced by <a class="el" href="xavb__ptp__bmca_8c.html#a5eaf575de699cb2f054a43daa8a93849">XAvb_DecodeRxAnnounceFrame()</a>, and <a class="el" href="xavb__ptp__bmca_8c.html#aa66e9752ef47bf7eafe4784cb59e1093">XAvb_ReadAnnounceReceiptTimeout()</a>.</p>

</div>
</div>
<a class="anchor" id="ae60a5e9cd8c572d2db805650287483f7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_avb___port_identity.html">XAvb_PortIdentity</a> XAvb_BmcData::SourcePortIdentity</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Announce message: sourcePortIdentity. </p>

<p>Referenced by <a class="el" href="xavb__ptp__bmca_8c.html#ae38ec83a381d57348fdbaf065c2190eb">XAvb_BestMasterClockAlgorithm()</a>, <a class="el" href="xavb__ptp__bmca_8c.html#a5eaf575de699cb2f054a43daa8a93849">XAvb_DecodeRxAnnounceFrame()</a>, <a class="el" href="xavb__ptp__packets_8c.html#afb8650c4c94082dc746db9ec0259e1cb">XAvb_DecodeRxFollowUp()</a>, <a class="el" href="xavb__ptp__packets_8c.html#a3ed6d94f92c94a88dce9444e8a27fe8a">XAvb_DecodeRxSync()</a>, <a class="el" href="xavb__ptp__bmca_8c.html#a7c77fd7953811584a36001e5e74165b3">XAvb_ReadAnnounceFrame()</a>, and <a class="el" href="xavb__ptp__bmca_8c.html#a2234b9dec3b039479123f49ee573a14e">XAvb_UpdateBmcRecords()</a>.</p>

</div>
</div>
<a class="anchor" id="aa82e09ae59ed634e54fdcfebe78d10d2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u16 XAvb_BmcData::stepsRemoved</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Announce message: stepsRemoved. </p>

<p>Referenced by <a class="el" href="xavb__ptp__bmca_8c.html#ae38ec83a381d57348fdbaf065c2190eb">XAvb_BestMasterClockAlgorithm()</a>, <a class="el" href="xavb__ptp__bmca_8c.html#a5eaf575de699cb2f054a43daa8a93849">XAvb_DecodeRxAnnounceFrame()</a>, <a class="el" href="xavb__ptp__bmca_8c.html#a7c77fd7953811584a36001e5e74165b3">XAvb_ReadAnnounceFrame()</a>, and <a class="el" href="xavb__ptp__bmca_8c.html#a2234b9dec3b039479123f49ee573a14e">XAvb_UpdateBmcRecords()</a>.</p>

</div>
</div>
<a class="anchor" id="a112462d30d91fae9ea7f01d6b275e3d0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u16 XAvb_BmcData::tlvLengthField</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Announce message: lengthField (for TLV) </p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
